home *** CD-ROM | disk | FTP | other *** search
/ Macwelt 1 / Macwelt DVD 1.toast / Web-Publishing / HTML-Editoren / Alpha ƒ / Help / VOODOO Help < prev   
Encoding:
Text File  |  2001-01-24  |  11.5 KB  |  336 lines
  1.  
  2. VOODOO Menu Help 
  3.  
  4.  
  5.                                                version: 2.0
  6.                                                created: 06/30/97 {11:13:46 pm} 
  7.                                            last update: 1/3/01 {11:08:16 AM}
  8.  
  9.  
  10.  
  11. IMPORTANT: This version of AlphaVOODOO only functions with Alpha v7.4,
  12. including those versions available from:
  13.  
  14.     <ftp://ftp.ucsd.edu/pub/alpha/>
  15.  
  16.  
  17. This package integrates the Alpha text editor
  18.  
  19.     <http://alpha.olm.net/>
  20.  
  21.  
  22. with the VOODOO (Versions Of Outdated Documents Organized Orthogonally)
  23. version management package:
  24.  
  25.     <http://www.unisoftsofwareplus.com/products/voodoo.html>
  26.  
  27.  
  28.     ----------------------------------------------------------------------
  29.  
  30.     
  31.           Projects
  32.  
  33.           
  34. Select the "VOODOO --> Connect --> Choose…" menu item to assign a VOODOO
  35. project.  Once selected, a settings dialog will be provided for the project
  36. before connecting to it.  The project name, for Alpha's purposes, is a near
  37. approximation of its actual name, with curly brackets removed and a number
  38. appended in the event of name conflicts.  The name can be changed by
  39. selecting "VOODOO --> Connect --> Rename…".  Each new project is added to the
  40. "VOODOO --> Connect" submenu for easy reconnection.
  41.  
  42. Currently, selection of a new project automatically disconnects the old one. 
  43. This is done, in part, because that's what the BBEdit extension does.  If you
  44. would like more than one project to remain connected for some reason, let me
  45. know.  The active project is also disconnected when you quit Alpha.  Let me
  46. know if this is a problem.
  47.           
  48. NOTE: Because of limitations in Alpha's AppleEvent interface, VOODOO will not
  49. be brought forward if there is anything wrong with your user name or
  50. password.  You'll get an alert (e.g., blinking icon in the menu bar) and you
  51. can manually shift to VOODOO, but it won't happen automatically.
  52.  
  53. There currently is no mechanism for creating VOODOO projects through
  54. AppleEvents, so you will need to create your project in VOODOO, but you can
  55. then use Alpha to define what files should be in the project (such as adding
  56. all open windows or all files of an Alpha fileset).  There is not currently a
  57. straight-forward way to determine what files are already in a project, such
  58. that an Alpha fileset could be created from an existing VOODOO project.  I
  59. know of a cumbersome way to do it, so if it's important to you, let me know
  60. and I'll see what I can do.
  61.  
  62.  
  63.           Settings
  64.  
  65.                User name
  66.  
  67. VOODOO uses the Macintosh's owner name as its default user name for a
  68. project.  Unfortunately, this name is not always available to Alpha. 
  69. AlphaVOODOO tries the following, in order, to set the user name for the
  70. project:
  71.  
  72. • Under Mac OS 8.x, get the the owner name from the File Sharing control
  73.   panel.
  74.   <<try {error::alertnote [tclAE::build::OS8userName]} -reporting taciturn>>
  75.  
  76. • Under Mac OS 7.x, or if the previous failed, get the owner of the
  77.   system's preferences file (almost certain to be the Mac's owner).
  78.   <<try {error::alertnote [tclAE::build::OS7userName]} -reporting taciturn>>
  79.  
  80. • As a last resort, such as if File Sharing is disabled, get the user name
  81.   from Internet Config.
  82.   <<try {error::alertnote [icGetPref RealName]} -reporting taciturn>>
  83.  
  84.                Variants
  85.         
  86. You may restrict the VOODOO variants which are visible by either typing the
  87. variant names in explicitly or by clicking the "Variants…" button in the
  88. "VOODOO --> Settings…" dialog.  As long as the project is logged on, a list
  89. of available variants will be provided, allowing you to select or
  90. <shift>-select the variant(s) you are interested in.  If the project is not
  91. logged on, the most recently available list will be provided, along with a
  92. warning that it is not current.
  93.  
  94. You may, if you get your jollies that way, type in the variant names. 
  95. Enclose each variant name in squirrely brackets, e.g.,
  96.  
  97. {Variant 1} {Variant 2} {Variant 3}
  98.  
  99.                Actions
  100.  
  101. Once Alpha is connected to a VOODOO project, files in Alpha may be 
  102.  
  103. • stored to
  104. • fetched from (read or read-only)
  105. • status checked against
  106. • added to 
  107.  
  108. that project.  Any of these actions may be performed on 
  109.  
  110. • the topmost window
  111. • all open windows
  112. • the current fileset 
  113.   (ftp filesets are not supported (any thoughts on what
  114.    this would even mean?))
  115.  
  116.                File comparison
  117.           
  118. Unlike the other version management actions, file comparison is only
  119. available for the topmost window.  In order to compare a file in Alpha with
  120. an archived file, you need VOODOO version 1.8.1 or greater; AlphaVOODOO
  121. knows this and will throw an error if it detects an earlier version.
  122.  
  123. Note: If you have more than one copy of Alpha, this action is
  124. unpredictable.  VOODOO always launches the copy of Alpha defined in the
  125. Desktop Database, rather than talking to the copy that's currently running. 
  126. There's nothing to be done about this from Alpha's end; it needs to be
  127. changed by UNISOFT.
  128.  
  129.                Customizing actions
  130.  
  131. Hold down the <option> key in the VOODOO menu to use VOODOO's dialog to make
  132. adjustments to Fetch, Store, and Add requests before completing them.
  133.  
  134.                Key bindings
  135.  
  136. To the curious: The key binding prefix for the "Window" operations,
  137. <command><shift><control>, was selected as having no (known) conflicts with
  138. other modes, thereby allowing all VOODOO commands to have the same
  139. bindings with "logical" letters.
  140.  
  141.           
  142.     ----------------------------------------------------------------------
  143.  
  144.  
  145.           Acknowledgments
  146.         
  147.  
  148. My thanks to Christoph Reichenberger for writing VOODOO in the first place,
  149. and for providing extensive help on this package in the second.
  150.  
  151. I'm indebted to Pete Keleher for having provided an editor worth connecting
  152. to and to Vince Darley for making it much easier to write packages.
  153.  
  154. I've borrowed liberally and shamelessly from Vince Darley's "Vince's
  155. Additions".  Thanks Vince!
  156.  
  157.  
  158.           To do
  159.         
  160.  
  161. • Implement VOODOO logs in browser mode.
  162.  
  163. • VOODOO should respect the currently running Alpha for compares, rather
  164.   than always launching the one in the Desktop Database.
  165.  
  166.  
  167.           Recent Changes
  168.  
  169.  
  170.                2.0         January 3, 2001
  171.  
  172.  
  173. • Compatibility with (and requirement of) AlphaTcl 7.4.
  174. • Verified compatibility with VOODOO Personal.
  175.  
  176.  
  177.                1.0.1       December 17, 1999
  178.  
  179.  
  180. • Compatibility with Tcl 8.x, from VMD.
  181. • URL revisions.
  182. • Installation fixes.
  183.  
  184.  
  185.                1.0.0       October 20, 1998
  186.  
  187.  
  188. • Release!
  189. • Documentation revisions.
  190. • Installation fixes.
  191.  
  192.  
  193.                1.0.0b7     May 6, 1998
  194.  
  195.  
  196. • Code reorganization.
  197. • Vince's updated menu tools used.
  198. • Updated aebuild/aeparse/aecoerce suite used for more automated 
  199.   handling of AppleEvents.
  200. • cmd argument removed from proc: voodoo::eligibleFiles.  upvar used 
  201.   now.
  202. • proc: voodoo::try more flexible and makes use of updated try command.
  203. • voodoo::*userName moved to "aebuild.tcl"
  204. • Overly clever upvar mechanism for changing projects eliminated.  
  205.   Master projects are now ordinally numbered, 
  206.   voodoo::projects::[0-9]+, and are swapped in and out of 
  207.   voodooProjects.
  208. • Incremental numbers on projects changed from "<nn>" to "[nn]" 
  209.   for better menu compatibility.
  210. • Minimum version of VOODOO for compares is 1.8.1.  Earlier betas 
  211.   worked too, but they have expired now.
  212.  
  213.  
  214.                1.0.0b6     March 1, 1998
  215.  
  216.  
  217. • AlphaVOODOO is a better citizen now, providing an uninstall 
  218.   script and cleaning up messes left by earlier installers.
  219. • Error catching and handling mechanism now much more general.
  220. • In the event that none of the selected files are eligible for 
  221.   VOODOO, e.g., shells, Diff reports, etc, an alert is now 
  222.   posted. Before, nothing happened at all.
  223. • Instead of setting the default project owner's name to 
  224.   InternetConfig's user name, which virtually never gave the 
  225.   correct result, AlphaVOODOO now obtains the Mac's owner 
  226.   name under MacOS 8.x and makes a pretty good guess under MacOS 
  227.   7.x (by using the owner of the Preference folder; almost 
  228.   certain to be the Mac's owner).
  229. • Old "appleEvents.tcl" calls replaced with new "aebuild.tcl" calls.
  230. • Various minor bug fixes.
  231. • VOODOO's new «event CompComp» is _not_ supported, due to lack 
  232.   of capability in Alpha's AppleEvent interface. 
  233.   'compareExternalFiles' renamed to 'proc: voodoo::compareFiles'.
  234. • Better integration with "diffMode.tcl" (requiring changes to 
  235.   both Diff mode and AlphaVOODOO). 
  236. • NOTE: Due to a crashing bug in Alpha, if an error is 
  237.   returned from a call to VOODOO while Alpha is in the 
  238.   background (switched either manually or from using the 
  239.   "With Dialog" menu option), an alert dialog will not be 
  240.   displayed.  As much of the message as possible will be 
  241.   displayed in the status bar, instead.
  242.          
  243.  
  244.                1.0.0b5     December 22, 1997
  245.  
  246.  
  247. • Further modernizations for Vince Darley's Alpha 7.  NOTE: 
  248.   As of this version, AlphaVOODOO is incompatible with Alpha 
  249.   6.5.x. Please contact me, supplying a note from your 
  250.   mother, if you are unable/unwilling to migrate to Alpha 7.
  251. • Support for the new «event compcomp» compare AE from 
  252.   VOODOO. As of VOODOO 1.8.1b6, the old "DoScript" interface 
  253.   is still used, unless Alpha's creator is changed from 
  254.   'ALFA'.  Either way, the new "diffMode.tcl" is exploited.   
  255. • Interim patch file "coreFixes+.tcl" that fixes the broken 
  256.   Alpha proc specToPathName.  If you have the December 20, 
  257.   1997 release of Alpha 7 or later (how 'bout some real 
  258.   version numbers, Vince?), this file is not needed, as both 
  259.   it and "aevt.tcl" are in the System code.
  260. • The code in "diff+.tcl" and "appleEvents+.tcl" has been 
  261.   incorporated in Alpha's core code.  These files may be (and 
  262.   should be) safely removed from Alpha's PREFS folder.
  263.  
  264.  
  265.                1.0.0b4     September 5, 1997
  266.  
  267.  
  268. • Installer now compliant with Vince Darley's new Tcl structure.  
  269.   Still works on old systems, too.
  270. • Project naming and selection now more flexible.
  271. • All files in fileset now stored and fetched with VOODOO, rather 
  272.   than just TEXT files.
  273. • Nice display of "Add" and "Locking Status" operations.  When 
  274.   VOODOO's AppleEvent model supports it, "Store" and "Fetch" will 
  275.   generate reports too.
  276.  
  277.  
  278.                1.0.0b3     August 10, 1997
  279.  
  280.  
  281. • Multiple VOODOO projects now supported, with easy menu 
  282.   selection.
  283. • Redesigned settings dialog.
  284. • Menu redesign; renamed some items and properly disable items 
  285.   when appropriate.
  286. • Changed key bindings to (the somewhat more cumbersome) 
  287.   <command><shift><control>.  The new bindings don't conflict 
  288.   with any other modes, so far as I know.
  289. • Improved display of locking-status and add results
  290. • More robust AppleEvent parsing and handling.
  291. • More comprehensive and robust error catching.
  292. • "Log On" and "Log Off" renamed to "Connect" and 
  293.   "Disconnect" at Christoph's suggestion.
  294.  
  295.  
  296.                1.0.0b2     July 15, 1997
  297.  
  298.  
  299. • Many error conditions eliminated or handled more gracefully.
  300. • No longer logs on automatically to select filters.
  301. • "Project Settings…" dialog sizes itself to the main screen.
  302. • Filters applied prior to each pertinant action, rather than
  303.   only when changed (the old way meant that the variant filters
  304.   assiged in Alpha might be ignored).
  305. • Much code commenting.
  306. • Improved log-in status check.
  307. • Most dialogs eliminated. User requested dialogs are now handled
  308.   entirely by VOODOO.
  309. • VOODOO's reply from 'compare' events is now handled properly.
  310. • Only currently open windows are refreshed after a fileset fetch.
  311.   Remaining files in fileset are fetched, but not opened.
  312. • Big VOODOO menu icon eliminated.
  313.  
  314.  
  315.                1.0.0b1     July 1, 1997
  316.  
  317.  
  318.     Original
  319.     
  320.  
  321.     ----------------------------------------------------------------------
  322.  
  323.  
  324.           License And Disclaimer
  325.  
  326.  
  327. This package is free software; you can redistribute it and/or modify it under
  328. the terms of the GNU General Public License.
  329.  
  330. Author: Jonathan Guyer
  331. E-mail: <jguyer@his.com>
  332.    www: <http://www.his.com/~jguyer/>
  333.  
  334.  Copyright (c) 1998-2000  Jonathan Guyer
  335.  
  336.